ソフトバンクまとめて支払い(随時決済) 利用承諾 API一覧
※idPass版にのみ対応しています。json版には対応しておりません。
HTTP仕様(.idPass)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
EntryTranSbAccept 取引登録
これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
ExecTranSbAccept 決済実行
これ以降の決済取引で必要となるトークンを返却します。
リクエスト
ShopID | 必須 半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass | 必須 半角英数桁
ショップパスワード
|
|
AccessID | 必須 半角英数32桁 固定
取引ID
|
|
AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
OrderID | 必須 半角英数記号27桁
オーダーID
|
|
ClientField1 | 全半角100バイト
加盟店自由項目1
|
|
ClientField2 | 全半角100バイト
加盟店自由項目2
|
|
ClientField3 | 全半角100バイト
加盟店自由項目3
|
|
RetURL | 必須 半角英数記号256桁
決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。 |
|
PaymentTermSec | 半角数字5桁
支払開始期限秒 お客様が【決済実行】から【決済開始】を呼び出すまでの期限です。 |
/payment/ExecTranSbAccept.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive
レスポンス
正常
AccessID | 半角英数32桁 固定
取引ID
|
|
---|---|---|
Token | 半角英数256桁 固定
トークン取引IDのハッシュ値を返却します。 |
|
StartURL | 半角英数記号256桁
支払手続き開始IFのURL支払手続き開始IFのURLを返却します。 |
|
StartLimitDate | 半角数字14桁
支払開始期限日時 支払手続き開始IFの呼び出し期限を返却します。 |
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=107c44550ac7f47cbc6dbef22c4c27fd&StartURL=https://x01.mul-pay.jp/payment/SbStart.idPass&StartLimitDate=20220722112429
ErrCode=E01&ErrInfo=E01040001
SbAcceptStart 決済開始
お客様をソフトバンクセンターへ誘導します。
リクエスト
AccessID | 必須 半角英数32桁 固定
取引ID【取引登録】で発行された値を設定します。 |
|
---|---|---|
Token | 必須 半角英数256桁 固定
トークン【決済実行】で発行された値を設定します。 |
/payment/SbAcceptStart.idPass
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=7zTgGKeccFSXt1GD2aA0aO1NpliOjXE9kynelaJET0SwBS7yYvxSiC0zeMVH+O4F
リダイレクトページサンプル
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
</head>
<body OnLoad='OnLoadEvent();'>
<form name="SbAcceptStartCall" action="{SbAcceptStartURL}" method="POST">
<noscript>
<center>
<h2>ソフトバンクまとめて支払い(B)の決済画面へ遷移します。</h2>
<input type="submit" value="続行">
</center>
</noscript>
<input type="hidden" name="AccessID" value="{AccessID}">
<input type="hidden" name="Token" value="{Token}">
</form>
<script >
<!--
function OnLoadEvent() {
document.SbAcceptStartCall.submit();
}
//-->
</script>
</body>
</html>
リダイレクト後、お客様はソフトバンクまとめて支払い(B)の画面へ遷移します。
決済結果受信
ソフトバンクセンターから、当サービスに認証・支払操作結果が通知されます。
認証・支払操作結果は、お客様が支払操作を完了した場合と認証・支払操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。
この決済結果は、ソフトバンクセンターの決済完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。
レスポンス
ShopID=tshop11223344&OrderID=ORDER0000001&Status=REGISTER&TranDate=20220722112429&SbAcceptCode=12345678901234&CheckString=207c44550ac7f47cbc6dbef22c4c27fd
ErrCode=E01&ErrInfo=E01040001
SbAcceptUserEnd 利用承諾終了
利用承諾の終了を行います。
リクエスト
ShopID | 必須 半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
AccessID | 必須 半角英数32桁 固定
取引ID
|
|
AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
OrderID | 必須 半角英数記号27桁
オーダーID
|
|
SbAcceptCode | 必須 半角英数14桁
SB承諾番号
|
/payment/SbAcceptUserEnd.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&SbAcceptCode=12345678901234
SearchTradeMulti 取引情報参照
対象取引の取引状態を取得します。
レスポンス
正常
Status |
現状態 UNPROCESSED:未決済 |
|
---|---|---|
ProcessDate | 半角数字14桁 固定
処理日時 処理を実施した日時を返却します。 |
|
JobCd |
処理区分 REGISTER:利用承諾 |
|
AccessID | 半角英数32桁 固定
取引ID
|
|
AccessPass | 半角英数32桁 固定
取引パスワード
|
|
ClientField1 | 全半角100バイト
加盟店自由項目1
|
|
ClientField2 | 全半角100バイト
加盟店自由項目2
|
|
ClientField3 | 全半角100バイト
加盟店自由項目3
|
|
PayType | 半角数字2桁
決済方法34:ソフトバンクまとめて支払い(利用承諾) |
|
SbAcceptCode | 半角英数14桁
SB承諾番号 |
|
ProcessLastDate | 半角数字14桁 固定
最終処理日時 利用承諾を行った日時、またはSB承諾番号を使用して随時決済を行った日時を返却します。 |
Status=REGISTER&ProcessDate=20220722112429&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&ClientField1=&ClientField2=&ClientField3=&PayType=34&SbAcceptCode=12345678901234&ProcessLastDate=20220722112429
ErrCode=E01&ErrInfo=E01040001